README LINUX

   1 -*-text-*---------------------------------------------------------------
   2 supercollider 3 for linux
   3 ------------------------------------------------------------------------
   4 $Id$
   5 ------------------------------------------------------------------------
   6
   7 ------------------------------------------------------------------------
   8 intro
   9 ------------------------------------------------------------------------
  10
  11 this is a port of james mccartney's supercollider synthesis engine
  12 (scsynth) and programming language (sclang) to linux. supercollider's
  13 main homepage is at and the source code can be obtained via SVN from
  14
  15    http://supercollider.sourceforge.net
  16
  17 It all started at this homepage:
  18
  19    http://www.audiosynth.com
  20
  21 to get further information on supercollider usage or development, you
  22 might consider subscribing to the mailing lists
  23
  24   http://www.beast.bham.ac.uk/research/sc_mailing_lists.shtml
  25
  26 ------------------------------------------------------------------------
  27 build requirements
  28 (most of these will be available in your linux distribution as packages )
  29 ------------------------------------------------------------------------
  30
  31  * gcc >= 3.0
  32
  33    http://www.gnu.org/software/gcc/
  34
  35    gcc versions < 3.0 are missing some required c++ features
  36
  37  * jack and libjack
  38
  39    http://jackit.sourceforge.net/
  40
  41    jack audio connection kit
  42
  43  * libsndfile >= 1.0
  44
  45    http://www.mega-nerd.com/libsndfile/
  46
  47    _the_ soundfile i/o library
  48
  49  * pkg-config >= 0.14.0
  50
  51    http://www.freedesktop.org/software/pkgconfig/
  52
  53    facilitates checking for installed packages when compiling from
  54    source
  55
  56  * scons >= 0.96
  57
  58    http://www.scons.org/
  59
  60    configuration and build tool based on python
  61
  62  * fftw >= 3.0
  63
  64    http://www.fftw.org/
  65
  66    fast FFT transform library (for frequency-domain analysis,
  67                                         phase-vocoder effects)
  68
  69 ------------------------------------------------------------------------
  70 build requirements (optional features)
  71 (most of these will be available in your linux distribution as packages )
  72 ------------------------------------------------------------------------
  73
  74  o alsa
  75
  76    http://www.alsa-project.org/
  77
  78    advanced linux sound architecture drivers and library, for sclang's
  79    MIDI interface
  80
  81  o libhowl (obsolete)
  82
  83    http://www.porchdogsoft.com/products/howl/
  84
  85    zeroconf service dicovery implementation
  86
  87  o libavahi-client
  88
  89    http://www.avahi.org/
  90
  91    a more powerful zeroconf service discovery implementation
  92
  93  o linux kernel >= 2.6
  94
  95    http://www.kernel.org/
  96
  97    for sclang's linux input device (LID) interface
  98
  99  o for scel: the Emacs interface see the README in the directory
 100    `editors/scel'
 101
 102  o for sced: the gedit interface see the README in the directory
 103    `editors/sced'
 104
 105  o for scvim: the vim interface see the README in the directory
 106    `editors/scvim'
 107
 108
 109 ------------------------------------------------------------------------
 110 build requirements (debian users)
 111 ------------------------------------------------------------------------
 112
 113 on debian (unstable) you can install the following packages and be set
 114 for building supercollider:
 115
 116    gcc
 117    libjack0.100.0-dev
 118    libsndfile1-dev
 119    libasound2-dev
 120    libavahi-client-dev
 121    pkg-config
 122    scons
 123
 124 ------------------------------------------------------------------------
 125 building
 126 ------------------------------------------------------------------------
 127
 128 building with scons is not really different from building with
 129 autoconf, automake and related tools.
 130
 131    $ scons -H
 132
 133 gives an overview of scons options.
 134
 135    $ scons -h
 136
 137 lists package specific options variables and their default values.
 138 (Note: some options allow to disable the dependencies on fftw and on
 139 libsndfile, but those dependencies should be considered compulsory for
 140 most standard setups since they provide much core sc functionality.)
 141
 142 options can be set on the command line
 143
 144    $ scons VARIABLE=VALUE
 145
 146 and are cached in a file called scache.conf (which can be edited with
 147 your favorite editor) for use in the next scons invocation.
 148
 149 in order to build the whole package, call scons without arguments
 150 (apart from option variables). in order to install the package, call
 151 scons with the `install' target:
 152
 153    $ scons install
 154
 155 any target (including `install') can be cleaned with the `-c' option
 156 to scons; note that cleaning the `install' target also removes locally
 157 built files.
 158
 159 The option SCEL installs the emacs editor. For the sced and scvim editors,
 160 please use the scons scripts in their respective directories (in editors/).
 161
 162 Note that the language will only build 32bit. To compile the language as
 163 32bit binary on a 64bit installation, a multilib compiler and 32bit
 164 libraries are required (on debian systems, the packages are gcc-multilib
 165 g++-multilib, ia32-libs, libc6-dev-i386 and lib32asound2-dev).
 166
 167
 168 ------------------------------------------------------------------------
 169 Building a Debian package
 170 ------------------------------------------------------------------------
 171
 172 In our SVN we have debian packaging rules. These were designed on Ubuntu
 173 but we believe they should work on most common debian systems - please
 174 let us know if you have any issues with this way of building:
 175
 176   cd SuperCollider3    # (or wherever your SC source is)
 177   svn co https://supercollider.svn.sourceforge.net/svnroot/supercollider/packages/ubuntu/ debian
 178   debuild
 179
 180 Eventually, some .deb packages will be put in the parent folder, and can
 181 then be installed just like any other Debian package. For example:
 182
 183   dpkg -i ../supercollider*.deb
 184
 185 (Note: the packages supercollider-scel*.deb, supercollider-scvim*.deb,
 186 supercollider-sced*.deb, represent the different editor integrations:
 187 emacs, vim, gedit. You might not want to install all of those, but
 188 choose your preferred editor.)
 189
 190
 191 ------------------------------------------------------------------------
 192 running scsynth (standalone)
 193 ------------------------------------------------------------------------
 194
 195 run scsynth without options to get an option summary. don't forget to
 196 start jackd before trying to use scsynth. if you want to add
 197 directories to supercollider's search path or assign default jack
 198 ports, set up your environment as described below.
 199
 200 you can specify the number of jack input/output channels created with
 201 the options -i and -o, respectively.
 202
 203 the -H option can be used to specify a jack server to connect to and
 204 to set the jack client identifier. the format is either
 205
 206     <SERVER-NAME>:<CLIENT-NAME>
 207
 208 or just
 209
 210     <CLIENT-NAME>
 211
 212 when connecting to the default server.
 213
 214 ------------------------------------------------------------------------
 215 running sclang
 216 ------------------------------------------------------------------------
 217
 218 it is recommended to use sclang in combination with the SCEL emacs
 219 interface in `scel'. see the README in `linux/scel' for installation
 220 and usage.
 221
 222 sclang executes the startup file `~/.sclang.sc' after class library
 223 initialization. this file can contain statements you don't want to put
 224 in a custom Main class, like setting default variables. an example can
 225 be found in `linux/examples/sclang.sc'.
 226
 227 you _have_ to have a directory `~/share/SuperCollider/'. This is where
 228 automatically a synthdefs directory is created. It is also the place
 229 to put Extensions to the class library, in a folder called Extensions.
 230
 231 the runtime directory is either the current working directory or the
 232 path specified with the `-d' option.
 233
 234 for advanced setups, sclang's compilation search path can be
 235 customized with a library configuration file. an example is provided
 236 in `linux/examples/sclang.cfg'; install it as `/etc/sclang.cfg' or
 237 `~/.sclang.cfg'. This config file is only needed when you want to
 238 _exclude_ directories from the class library. Otherwise (so in most cases)
 239 it is not needed.
 240
 241 ------------------------------------------------------------------------
 242 environment
 243 ------------------------------------------------------------------------
 244
 245 the jack audio driver interface is configured based on various
 246 environment variables:
 247
 248  * SC_JACK_DEFAULT_INPUTS comma separated list of jack ports that
 249    scsynth's inputs should connect to by default
 250
 251    $ export SC_JACK_DEFAULT_INPUTS="system:capture_1,system:capture_2"
 252
 253    in order to connect the first ports of one jack client, it is possible
 254    to specify only the client name
 255
 256    $ export SC_JACK_DEFAULT_INPUTS="system"
 257
 258  * SC_JACK_DEFAULT_OUTPUTS comma separated list of jack ports that
 259    scsynth's outputs should be connected to by default.
 260
 261    $ export SC_JACK_DEFAULT_OUTPUTS="system:playback_1,system:playback_2"
 262
 263    in order to connect the first ports of one jack client, it is possible
 264    to specify only the client name
 265
 266    $ export SC_JACK_DEFAULT_OUTPUTS="system"
 267
 268 two additional environment variables substitute directories for the default
 269 search path for plugins and synth definitions, respectively. directory
 270 names are separated by ':' as in the unix PATH variable:
 271
 272  * SC_PLUGIN_PATH, SC_SYNTHDEF_PATH
 273
 274    $ export SC_SYNTHDEF_PATH="./synthdefs:/home/sk/SuperCollider/synthdefs"
 275
 276 ------------------------------------------------------------------------
 277 documentation
 278 ------------------------------------------------------------------------
 279
 280 apart from the sites listed above, some more documentation links ...
 281
 282 a wiki for supercollider, set up by julian rohrhuber, is at
 283
 284     http://swiki.hfbk-hamburg.de:8888/MusicTechnology/6
 285
 286 linux specific information can be found at
 287
 288     http://swiki.hfbk-hamburg.de:8888/MusicTechnology/478
 289
 290 if and when i get around to update the site, you'll find some more at
 291
 292    http://v00d00.k-hornz.de/sc.html
 293
 294 ------------------------------------------------------------------------
 295 reporting bugs
 296 ------------------------------------------------------------------------
 297
 298 please report bugs either to the sc-users or sc-dev mailing lists.
 299
 300 ------------------------------------------------------------------------
 301 contributors
 302 ------------------------------------------------------------------------
 303
 304 stefan kersten <sk AT k-hornz DOT de>
 305 andi pieper
 306 maurizio umberto puxeddu
 307 rohan drape
 308 mario lang
 309 john yates
 310 nescivi (marije baalman)
 311
 312 ------------------------------------------------------------------------
 313 outro
 314 ------------------------------------------------------------------------
 315
 316 thanks to james mccartney, for making this great piece of audio
 317 software publically and freely available.
 318
 319 ------------------------------------------------------------------------
 320 eof
 321 ------------------------------------------------------------------------